custom-event

What is custom-event?

The custom-event npm package allows developers to create and manage custom events in JavaScript environments. This package is particularly useful for handling custom event-driven interactions in applications, making it easier to manage asynchronous code and event-based logic.

What are custom-event's main functionalities?

Creating custom events

This feature allows developers to create a new custom event with a specified type and optional details. The event can then be dispatched to trigger event listeners that are set up to respond to it.

const CustomEvent = require('custom-event');
const event = new CustomEvent('my-event', { detail: { message: 'Hello world!' } });
document.dispatchEvent(event);

Listening to custom events

This code sets up an event listener for 'my-event'. When this event is dispatched, the listener triggers and logs the message contained in the event's details.

document.addEventListener('my-event', function(e) { console.log(e.detail.message); });

Other packages similar to custom-event

eventemitter3

EventEmitter3 is a high-performance event emitter. It provides similar functionalities to custom-event but with a focus on performance and additional features like wildcard listeners. Compared to custom-event, EventEmitter3 offers a broader API for managing events in more complex scenarios.

wolfy87-eventemitter

Wolfy87's EventEmitter is another alternative that offers a similar event management system. It supports features like namespaced events, which can help in organizing event types and listeners more efficiently. It is more feature-rich compared to custom-event, providing more flexibility in handling events.

README

custom-event

Cross-browser CustomEvent constructor

https://developer.mozilla.org/en-US/docs/Web/API/CustomEvent.CustomEvent

Installation

$ npm install custom-event

Example

var CustomEvent = require('custom-event');

// add an appropriate event listener
target.addEventListener('cat', function(e) { process(e.detail) });

// create and dispatch the event
var event = new CustomEvent('cat', {
  detail: {
    hazcheeseburger: true
  }
});
target.dispatchEvent(event);